Skip to content

docs: document org-wide record activity views and filters [sc-17354] - #1450

Merged
emmavdh merged 4 commits into
mainfrom
emma/sc-17354/docs-for-sc-16807
Jul 30, 2026
Merged

docs: document org-wide record activity views and filters [sc-17354]#1450
emmavdh merged 4 commits into
mainfrom
emma/sc-17354/docs-for-sc-16807

Conversation

@emmavdh

@emmavdh emmavdh commented Jul 30, 2026 •
edited
Loading

Copy link
Copy Markdown
Collaborator

What and why?

Documents organization-wide Record Activity vs per-record Activity for SC-17354 / SC-16807 (epic 15038), and updates Settings Activity for the same filter rollout.

Implementation: frontend#2734, backend#3380.

Before: View record activity only described opening Activity from a single inventory record and its Event Category / Filter by Value popover. View settings activity still described an Event Type-only filter and omitted several shipped audit scopes.

After:

  • Intro and overview clarify organization-wide Activity → Record Activity vs a record's Activity page
  • View record activity uses tabs for both entry points
  • Filter record activity documents org-wide Activity Filter + Record/Artifact Filter (including downstream artifact behavior) separately from per-record filters
  • View settings activity documents the query-builder filters (Category, Action, Actor, Target Type) and expands what is tracked (risk tiering, record stages/custom fields, finding statuses, workflow states, global charters)
  • Tracking landing blurb and chatbot product map (/activity) updated via keyword mapping so regenerate keeps the links

How to test

  1. Mark this PR ready for review (draft PRs skip the preview validate job).
  2. Wait for the validate check to pass and deploy the hosted preview.
  3. Review the updated pages on the PR preview (compare with production as needed):
  4. Confirm Record Activity distinguishes:
    • Org-wide: left sidebar Activity → Record Activity
    • Per-record: Inventory → record → Activity
  5. Confirm org-wide record filters document Activity Filter and Record/Artifact Filter, and that record-attribute filters include downstream artifact activity.
  6. Confirm Settings Activity documents query-builder fields (Category, Action, Actor, Target Type) instead of Event Type-only, and that What is tracked includes risk tiering and the other expanded scopes.
  7. Confirm per-record filters still document Event Category / Filter by Value.

Production for side-by-side comparison:

Optional local render:

skills/validmind-docs-coverage/scripts/render-pages.sh \
  guide/reporting/view-record-activity.qmd \
  guide/reporting/view-settings-activity.qmd \
  guide/reporting/tracking-organization-activity.qmd \
  training/administrator-fundamentals/organizational-oversight-reporting.qmd

What needs special review?

  • Org-wide record filter field lists follow the shipped field_schema (hidden FE fields such as Linked Model / Template / Current step are omitted).
  • Settings Category labels follow FE display names (formatScopeDisplay) where they differ from raw scopes (for example Inventory Records, Risk Assessments, Record Fields).
  • Shared overview/steps includes are used by training slides — wording kept compatible with RevealJS consumers.

Dependencies, breaking changes, and deployment notes

  • Depends on merged FE/BE work for SC-16807 (org-wide activity filters; LD flag launchdarkly.rollout.org-wide-activity-filters, offline default on)
  • No breaking docs changes

Release notes

You can review and filter record and artifact activity organization-wide from Activity, including filters on event dimensions and current record or artifact fields. Settings Activity uses the same query-builder style filters for configuration audit events. Learn more ...

Checklist

  • What and why
  • Screenshots or videos (Frontend)
  • How to test
  • What needs special review
  • Dependencies, breaking changes, and deployment notes
  • Labels applied (documentation)
  • PR linked to Shortcut
  • Unit tests added (Backend)
  • Tested locally
  • Documentation updated (if required)
  • Environment variable additions/changes documented (if required)

@emmavdh emmavdh added the documentation Improvements or additions to documentation label Jul 30, 2026
@CLAassistant

CLAassistant commented Jul 30, 2026 •
edited
Loading

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@emmavdh
emmavdh marked this pull request as ready for review July 30, 2026 14:53
@github-actions

github-actions Bot commented Jul 30, 2026

Copy link
Copy Markdown
Contributor

Lighthouse check results

✓ INFO: Average accessibility score is 0.92 (required: ≥0.9) — View the workflow run

Audit mode: changed pages (2 URL(s))

Show Lighthouse scores

Commit SHA: a850986

For a thorough audit, run the Lighthouse check workflow manually (Actions → Lighthouse check → Run workflow) with depth 0–2, or add the lighthouse:full label for depth 2 on the next validate run.

Page Accessibility Performance Best Practices SEO
/guide/reporting/tracking-organization-activity.html 0.91 0.70 1.00 0.82
/guide/reporting/tracking-organization-activity.html 0.91 0.75 1.00 0.82
/guide/reporting/view-record-activity.html 0.93 0.75 1.00 0.82
/guide/reporting/view-record-activity.html 0.93 0.76 1.00 0.82
/guide/reporting/tracking-organization-activity.html 0.91 0.75 1.00 0.82
/guide/reporting/view-record-activity.html 0.93 0.73 1.00 0.82

@emmavdh
emmavdh marked this pull request as draft July 30, 2026 16:15
@emmavdh
emmavdh marked this pull request as ready for review July 30, 2026 16:37
@cachafla

cachafla commented Jul 30, 2026

Copy link
Copy Markdown
Contributor

@emmavdh small suggestion - I'd remove this bullet point from "What is tracked on settings activity?" here: https://docs-staging.validmind.ai/pr_previews/emma/sc-17354/docs-for-sc-16807/guide/reporting/view-settings-activity.html

"Global charter settings, including charter creation, updates, moves, and deletions"

@emmavdh
emmavdh force-pushed the emma/sc-17354/docs-for-sc-16807 branch from 6858e43 to fe44f9e Compare July 30, 2026 19:02
emmavdh and others added 4 commits July 30, 2026 15:21
@emmavdh @cursoragent
docs: document org-wide record activity views and filters [sc-17354]
79cee2e 
Clarify organization-wide Activity vs per-record Activity, and document the Activity Filter and Record/Artifact Filter tabs from SC-16807.

Co-authored-by: Cursor <cursoragent@cursor.com>
@github-actions @emmavdh
chore: refresh chatbot product map
3d4b31e
@emmavdh @cursoragent
docs: update Settings Activity filters and tracked categories [sc-17354]
92a4ac1 
Document the SC-16807 query-builder fields for Settings Activity and expand what is tracked to match shipped audit scopes.

Co-authored-by: Cursor <cursoragent@cursor.com>
@emmavdh @cursoragent
docs: refine Settings Activity tracked categories wording [sc-17354]
125a0cf 
Align overview and category filter copy with attestation governance events and clearer inventory/workflow wording.

Co-authored-by: Cursor <cursoragent@cursor.com>
@emmavdh
emmavdh force-pushed the emma/sc-17354/docs-for-sc-16807 branch from fe44f9e to 125a0cf Compare July 30, 2026 19:21
@github-actions

github-actions Bot commented Jul 30, 2026

Copy link
Copy Markdown
Contributor

Validate docs site

✓ INFO: A live preview of the docs site is available — Open the preview

panchicore
panchicore approved these changes Jul 30, 2026
View reviewed changes

@panchicore panchicore left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🌮 LGTM

@emmavdh
emmavdh added this pull request to the merge queue Jul 30, 2026
Merged via the queue into main with commit 483a882 Jul 30, 2026
4 of 5 checks passed
@emmavdh
emmavdh deleted the emma/sc-17354/docs-for-sc-16807 branch July 30, 2026 20:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@cachafla cachafla cachafla approved these changes
@panchicore panchicore panchicore approved these changes
@nibalizer nibalizer Awaiting requested review from nibalizer

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@emmavdh @CLAassistant @cachafla @panchicore